<HTML>
<HEAD>
<TITLE>HELP - HowToDocument</TITLE>
<script type="text/javascript">
  var relPathToCommmon = "../../common/";
  var relPathToHelpDir = "../../common/help/";
</script>
<script type="text/javascript" src="../../common/jsdyn.js" language="JavaScript"></script>
<script type="text/javascript" src="../../common/js.js" language="JavaScript"></script>
<script type="text/javascript" src="leftmenu.js" language="JavaScript"></script>
<script type="text/javascript">
  var toSearchPage     = "_search','../../search";
  Body1();
</script>
<div class="headerPage">HELP - HowToDocument</div>
<div class="path"><a href="#" OnMouseOver="link('','../../index',this)" class="pathLink">Help</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_dir','ExampleCode0',this)" class="pathLink">Example Code</A><img src="../../common/path-arrow.gif" class="path-arrow"><span class="pathNonLink">HowToDocument</span></div>
<script type="text/javascript">
 Body2();
 BodyLeftMenuStart();
WriteLeftMenu("divID601","aID601","LeftMenuActive","leftMenuLinkActive");
 BodyLeftMenuEnd();
 Body3();
</script>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_class','HowToDocument0','_description',this)" class="tabLinkInActive">Description</a></span>
<span class="tabActive"><a href="#" OnMouseOver="linkTab('_class','HowToDocument0','_public',this)" class="tabLinkActive">Public</a></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Protected</span></span>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_class','HowToDocument0','_private',this)" class="tabLinkInActive">Private</a></span>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_class','HowToDocument0','_related',this)" class="tabLinkInActive">Related</a></span>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_class','HowToDocument0','_all',this)" class="tabLinkInActive">All</a></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Inheritance</span></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Collaboration</span></span>
<script type="text/javascript">
 Body4();
</script>
<div id="Simple">
<div class="contentAirTop"></div>
<div class="padding">
<a href="javascript:hideElement( 'Simple' );javascript:showElementStoreCookie( 'Inherited', cookieInnerNameAllInheritance );">
<img src="../../common/expand.gif" border=0>&nbsp;Show all inherited</a></div>
<table cellspacing="0"cellpadding=0 border=0 class="widthAndBorderTop">
<TR VALIGN="top">
<TD class="paddingHeadMultiColumn1"><span class="" align=left>Methods</TD>
<TD class="paddingHeadMultiColumn2"><span class="" align=left>Brief description</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Author2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Author&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Example of function with different author than of the<BR>containing class.');" onmouseout="return nd();">&nbsp;Author</a></TD>
<TD class="paddingNormal2"><span class="" >Example of function with different author than of the containing class.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','BriefAndDescription2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;BriefAndDescription&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>The brief description ends at first punctuation mark<BR>(or see BriefToNewline).');" onmouseout="return nd();">&nbsp;BriefAndDescription</a></TD>
<TD class="paddingNormal2"><span class="" >The brief description ends at first punctuation mark (or see <a href="#" OnMouseOver="link('_member','BriefToNewline2587069908',this)">BriefToNewline</a>).<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','BriefCmd2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;BriefCmd&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>This is a brief description which spans several lines<BR>of text. It continues until a blank line or until a new<BR>section command is encountered');" onmouseout="return nd();">&nbsp;BriefCmd</a></TD>
<TD class="paddingNormal2"><span class="" >This is a brief description which spans several lines of text. It continues until a blank line or until a new section command is encountered<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','BriefToNewline2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;BriefToNewline&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>The brief description ends at first newline');" onmouseout="return nd();">&nbsp;BriefToNewline</a></TD>
<TD class="paddingNormal2"><span class="" >The brief description ends at first newline<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Bug2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Bug&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Documenting a bug.');" onmouseout="return nd();">&nbsp;Bug</a></TD>
<TD class="paddingNormal2"><span class="" ><a href="#" OnMouseOver="link('_dir','../Documenting/Documenting0',this)">Documenting</a> a bug.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','CppDocCommentStyle2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;CppDocCommentStyle&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Document using multiple lines preceeded with ///.');" onmouseout="return nd();">&nbsp;CppDocCommentStyle</a></TD>
<TD class="paddingNormal2"><span class="" >Document using multiple lines preceeded with ///.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Deprecated2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Deprecated&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Example of deprecated function.');" onmouseout="return nd();">&nbsp;Deprecated</a></TD>
<TD class="paddingNormal2"><span class="" >Example of deprecated function.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','ExampleInclude2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;ExampleInclude&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>How to include an example.');" onmouseout="return nd();">&nbsp;ExampleInclude</a></TD>
<TD class="paddingNormal2"><span class="" >How to include an example.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','ExampleInline2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;ExampleInline&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>How to write an example (ie not including from file).');" onmouseout="return nd();">&nbsp;ExampleInline</a></TD>
<TD class="paddingNormal2"><span class="" >How to write an example (ie not including from file).<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','ExceptionsThrown2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;ExceptionsThrown&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Documenting exceptions thrown by a function.');" onmouseout="return nd();">&nbsp;ExceptionsThrown</a></TD>
<TD class="paddingNormal2"><span class="" ><a href="#" OnMouseOver="link('_dir','../Documenting/Documenting0',this)">Documenting</a> exceptions thrown by a function.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','IncludeDocFromBody2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;IncludeDocFromBody&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Include documentation from function body.');" onmouseout="return nd();">&nbsp;IncludeDocFromBody</a></TD>
<TD class="paddingNormal2"><span class="" >Include documentation from function body.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','InlineFormattedCode2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;InlineFormattedCode&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>How to inline formatted code in the documentation.');" onmouseout="return nd();">&nbsp;InlineFormattedCode</a></TD>
<TD class="paddingNormal2"><span class="" >How to inline formatted code in the documentation.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Internal2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Internal&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Making internal documentation.');" onmouseout="return nd();">&nbsp;Internal</a></TD>
<TD class="paddingNormal2"><span class="" >Making internal documentation.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Note2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Note&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Making notes to the reader of the documentation.');" onmouseout="return nd();">&nbsp;Note</a></TD>
<TD class="paddingNormal2"><span class="" >Making notes to the reader of the documentation.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','OrgDoxygenDocComment2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;OrgDoxygenDocComment&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Using original doxygen style doc-comments.');" onmouseout="return nd();">&nbsp;OrgDoxygenDocComment</a></TD>
<TD class="paddingNormal2"><span class="" >Using original doxygen style doc-comments.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','ParameterDocCombined955320382',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>int&nbsp;&nbsp;ParameterDocCombined<BR>(int iSize, HowToDocument & howToDocument, float fMAX2)',CAPTION,'<strong>Brief description</strong><BR>Combining the ways to doc parameters for the template.');" onmouseout="return nd();">&nbsp;ParameterDocCombined<></a></TD>
<TD class="paddingNormal2"><span class="" >Combining the ways to doc parameters for the template.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Parameters4173613626',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Parameters<BR>(int iSize, HowToDocument & howToDocument, float fMAX2)',CAPTION,'<strong>Brief description</strong><BR>Parameter documentation - normal style in CPP file.');" onmouseout="return nd();">&nbsp;Parameters</a></TD>
<TD class="paddingNormal2"><span class="" >Parameter documentation - normal style in CPP file.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','ParametersJavaStyle4173613626',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;ParametersJavaStyle<BR>(int iSize, HowToDocument & howToDocument, float fMAX2)',CAPTION,'<strong>Brief description</strong><BR>Parameter documentation - JavaDoc style.');" onmouseout="return nd();">&nbsp;ParametersJavaStyle</a></TD>
<TD class="paddingNormal2"><span class="" >Parameter documentation - JavaDoc style.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','ParametersTemplates2482800282',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;ParametersTemplates&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Template parameter documentation.');" onmouseout="return nd();">&nbsp;ParametersTemplates<></a></TD>
<TD class="paddingNormal2"><span class="" ><a href="#" OnMouseOver="link('_class','Template23971',this)">Template</a> parameter documentation.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Remark2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Remark&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Making remarks to the reader of the documentation.');" onmouseout="return nd();">&nbsp;Remark</a></TD>
<TD class="paddingNormal2"><span class="" >Making remarks to the reader of the documentation.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','ReturnValue2095680291',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>int&nbsp;&nbsp;ReturnValue&nbsp;&nbsp;() const',CAPTION,'<strong>Brief description</strong><BR>Documenting return values.');" onmouseout="return nd();">&nbsp;ReturnValue</a></TD>
<TD class="paddingNormal2"><span class="" ><a href="#" OnMouseOver="link('_dir','../Documenting/Documenting0',this)">Documenting</a> return values.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','SeeAlso2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;SeeAlso&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Making \'See Also\' sections.');" onmouseout="return nd();">&nbsp;SeeAlso</a></TD>
<TD class="paddingNormal2"><span class="" >Making "See Also" sections.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Since2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Since&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Information on when this entity was added to the API.');" onmouseout="return nd();">&nbsp;Since</a></TD>
<TD class="paddingNormal2"><span class="" >Information on when this entity was added to the API.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Todo2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Todo&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Making todo\'s (internal use mainly).');" onmouseout="return nd();">&nbsp;Todo</a></TD>
<TD class="paddingNormal2"><span class="" >Making todo's (internal use mainly).<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Version2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Version&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Designating a version.');" onmouseout="return nd();">&nbsp;Version</a></TD>
<TD class="paddingNormal2"><span class="" >Designating a version.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Warning2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Warning&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Making warning sections.');" onmouseout="return nd();">&nbsp;Warning</a></TD>
<TD class="paddingNormal2"><span class="" >Making warning sections.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingHeadMultiColumn1"><span class="" align=left>Types</TD>
<TD class="paddingHeadMultiColumn2"><span class="" align=left>&nbsp;</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','eAnonEnumVal1171347412',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>enumval&nbsp;&nbsp;eAnonEnumVal1',CAPTION,'<strong>Brief description</strong><BR>eAnonEnumVal1 anonymous enum value description.');" onmouseout="return nd();">&nbsp;eAnonEnumVal1</a></TD>
<TD class="paddingNormal2"><span class="" ><a href="#" OnMouseOver="link('_member','eAnonEnumVal1171347412',this)">eAnonEnumVal1</a> anonymous enum <b>value</b> description.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','eAnonEnumVal2171347412',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>enumval&nbsp;&nbsp;eAnonEnumVal2',CAPTION,'<strong>Brief description</strong><BR>eAnonEnumVal2 anonymous enum value description.');" onmouseout="return nd();">&nbsp;eAnonEnumVal2</a></TD>
<TD class="paddingNormal2"><span class="" ><a href="#" OnMouseOver="link('_member','eAnonEnumVal2171347412',this)">eAnonEnumVal2</a> anonymous enum <b>value</b> description.<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','eAnonEnumVal3171347412',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>enumval&nbsp;&nbsp;eAnonEnumVal3',CAPTION,'<strong>Brief description</strong><BR>eAnonEnumVal3 anonymous enum value description');" onmouseout="return nd();">&nbsp;eAnonEnumVal3</a></TD>
<TD class="paddingNormal2"><span class="" ><a href="#" OnMouseOver="link('_member','eAnonEnumVal3171347412',this)">eAnonEnumVal3</a> anonymous enum <b>value</b> description<br>
</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Enum171347412',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Enumeration Values</strong><BR>eEnumVal1<br>eEnumVal2<br>eEnumVal3<br>',CAPTION,'<strong>Brief description</strong><BR>Enumeration documentation.');" onmouseout="return nd();">&nbsp;Enum</a></TD>
<TD class="paddingNormal2"><span class="" >Enumeration documentation.<br>
</TD>
</TR>
</table>
<div class="contentAirBottom"></div>
</div>
<div id="Inherited" style="display:none;visibility:hidden">
<div class="contentAirTop"></div>
<div class="padding">
<a href="javascript:hideElement( 'Inherited' );javascript:showElementStoreCookie( 'Simple', cookieInnerNameAllInheritance );">
<img src="../../common/collapse.gif" border=0>&nbsp;Hide all inherited</a></div>
<table cellspacing="0"cellpadding=0 border=0 class="widthAndBorderTop">
<TR VALIGN="top">
<TD class="paddingHeadMultiColumn1"><span class="" align=left>Methods</TD>
<TD class="paddingHeadMultiColumn1"><span class="" align=left>Brief description</TD>
<TD class="paddingHeadMultiColumn2"><span class="" align=left>Parent</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Author2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Author&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Example of function with different author than of the<BR>containing class.');" onmouseout="return nd();">&nbsp;Author</a></TD>
<TD class="paddingNormal1"><span class="" >Example of function with different author than of the containing class.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','BriefAndDescription2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;BriefAndDescription&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>The brief description ends at first punctuation mark<BR>(or see BriefToNewline).');" onmouseout="return nd();">&nbsp;BriefAndDescription</a></TD>
<TD class="paddingNormal1"><span class="" >The brief description ends at first punctuation mark (or see <a href="#" OnMouseOver="link('_member','BriefToNewline2587069908',this)">BriefToNewline</a>).<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','BriefCmd2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;BriefCmd&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>This is a brief description which spans several lines<BR>of text. It continues until a blank line or until a new<BR>section command is encountered');" onmouseout="return nd();">&nbsp;BriefCmd</a></TD>
<TD class="paddingNormal1"><span class="" >This is a brief description which spans several lines of text. It continues until a blank line or until a new section command is encountered<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','BriefToNewline2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;BriefToNewline&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>The brief description ends at first newline');" onmouseout="return nd();">&nbsp;BriefToNewline</a></TD>
<TD class="paddingNormal1"><span class="" >The brief description ends at first newline<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Bug2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Bug&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Documenting a bug.');" onmouseout="return nd();">&nbsp;Bug</a></TD>
<TD class="paddingNormal1"><span class="" ><a href="#" OnMouseOver="link('_dir','../Documenting/Documenting0',this)">Documenting</a> a bug.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','CppDocCommentStyle2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;CppDocCommentStyle&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Document using multiple lines preceeded with ///.');" onmouseout="return nd();">&nbsp;CppDocCommentStyle</a></TD>
<TD class="paddingNormal1"><span class="" >Document using multiple lines preceeded with ///.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Deprecated2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Deprecated&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Example of deprecated function.');" onmouseout="return nd();">&nbsp;Deprecated</a></TD>
<TD class="paddingNormal1"><span class="" >Example of deprecated function.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','ExampleInclude2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;ExampleInclude&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>How to include an example.');" onmouseout="return nd();">&nbsp;ExampleInclude</a></TD>
<TD class="paddingNormal1"><span class="" >How to include an example.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','ExampleInline2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;ExampleInline&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>How to write an example (ie not including from file).');" onmouseout="return nd();">&nbsp;ExampleInline</a></TD>
<TD class="paddingNormal1"><span class="" >How to write an example (ie not including from file).<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','ExceptionsThrown2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;ExceptionsThrown&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Documenting exceptions thrown by a function.');" onmouseout="return nd();">&nbsp;ExceptionsThrown</a></TD>
<TD class="paddingNormal1"><span class="" ><a href="#" OnMouseOver="link('_dir','../Documenting/Documenting0',this)">Documenting</a> exceptions thrown by a function.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','IncludeDocFromBody2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;IncludeDocFromBody&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Include documentation from function body.');" onmouseout="return nd();">&nbsp;IncludeDocFromBody</a></TD>
<TD class="paddingNormal1"><span class="" >Include documentation from function body.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','InlineFormattedCode2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;InlineFormattedCode&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>How to inline formatted code in the documentation.');" onmouseout="return nd();">&nbsp;InlineFormattedCode</a></TD>
<TD class="paddingNormal1"><span class="" >How to inline formatted code in the documentation.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Internal2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Internal&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Making internal documentation.');" onmouseout="return nd();">&nbsp;Internal</a></TD>
<TD class="paddingNormal1"><span class="" >Making internal documentation.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Note2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Note&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Making notes to the reader of the documentation.');" onmouseout="return nd();">&nbsp;Note</a></TD>
<TD class="paddingNormal1"><span class="" >Making notes to the reader of the documentation.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','OrgDoxygenDocComment2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;OrgDoxygenDocComment&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Using original doxygen style doc-comments.');" onmouseout="return nd();">&nbsp;OrgDoxygenDocComment</a></TD>
<TD class="paddingNormal1"><span class="" >Using original doxygen style doc-comments.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','ParameterDocCombined955320382',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>int&nbsp;&nbsp;ParameterDocCombined<BR>(int iSize, HowToDocument & howToDocument, float fMAX2)',CAPTION,'<strong>Brief description</strong><BR>Combining the ways to doc parameters for the template.');" onmouseout="return nd();">&nbsp;ParameterDocCombined<></a></TD>
<TD class="paddingNormal1"><span class="" >Combining the ways to doc parameters for the template.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Parameters4173613626',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Parameters<BR>(int iSize, HowToDocument & howToDocument, float fMAX2)',CAPTION,'<strong>Brief description</strong><BR>Parameter documentation - normal style in CPP file.');" onmouseout="return nd();">&nbsp;Parameters</a></TD>
<TD class="paddingNormal1"><span class="" >Parameter documentation - normal style in CPP file.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','ParametersJavaStyle4173613626',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;ParametersJavaStyle<BR>(int iSize, HowToDocument & howToDocument, float fMAX2)',CAPTION,'<strong>Brief description</strong><BR>Parameter documentation - JavaDoc style.');" onmouseout="return nd();">&nbsp;ParametersJavaStyle</a></TD>
<TD class="paddingNormal1"><span class="" >Parameter documentation - JavaDoc style.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','ParametersTemplates2482800282',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;ParametersTemplates&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Template parameter documentation.');" onmouseout="return nd();">&nbsp;ParametersTemplates<></a></TD>
<TD class="paddingNormal1"><span class="" ><a href="#" OnMouseOver="link('_class','Template23971',this)">Template</a> parameter documentation.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Remark2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Remark&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Making remarks to the reader of the documentation.');" onmouseout="return nd();">&nbsp;Remark</a></TD>
<TD class="paddingNormal1"><span class="" >Making remarks to the reader of the documentation.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','ReturnValue2095680291',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>int&nbsp;&nbsp;ReturnValue&nbsp;&nbsp;() const',CAPTION,'<strong>Brief description</strong><BR>Documenting return values.');" onmouseout="return nd();">&nbsp;ReturnValue</a></TD>
<TD class="paddingNormal1"><span class="" ><a href="#" OnMouseOver="link('_dir','../Documenting/Documenting0',this)">Documenting</a> return values.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','SeeAlso2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;SeeAlso&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Making \'See Also\' sections.');" onmouseout="return nd();">&nbsp;SeeAlso</a></TD>
<TD class="paddingNormal1"><span class="" >Making "See Also" sections.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Since2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Since&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Information on when this entity was added to the API.');" onmouseout="return nd();">&nbsp;Since</a></TD>
<TD class="paddingNormal1"><span class="" >Information on when this entity was added to the API.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Todo2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Todo&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Making todo\'s (internal use mainly).');" onmouseout="return nd();">&nbsp;Todo</a></TD>
<TD class="paddingNormal1"><span class="" >Making todo's (internal use mainly).<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Version2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Version&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Designating a version.');" onmouseout="return nd();">&nbsp;Version</a></TD>
<TD class="paddingNormal1"><span class="" >Designating a version.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Warning2587069908',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;Warning&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Making warning sections.');" onmouseout="return nd();">&nbsp;Warning</a></TD>
<TD class="paddingNormal1"><span class="" >Making warning sections.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingHeadMultiColumn1"><span class="" align=left>Types</TD>
<TD class="paddingHeadMultiColumn1"><span class="" align=left>&nbsp;</TD>
<TD class="paddingHeadMultiColumn2"><span class="" align=left>&nbsp;</TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','eAnonEnumVal1171347412',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>enumval&nbsp;&nbsp;eAnonEnumVal1',CAPTION,'<strong>Brief description</strong><BR>eAnonEnumVal1 anonymous enum value description.');" onmouseout="return nd();">&nbsp;eAnonEnumVal1</a></TD>
<TD class="paddingNormal1"><span class="" ><a href="#" OnMouseOver="link('_member','eAnonEnumVal1171347412',this)">eAnonEnumVal1</a> anonymous enum <b>value</b> description.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','eAnonEnumVal2171347412',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>enumval&nbsp;&nbsp;eAnonEnumVal2',CAPTION,'<strong>Brief description</strong><BR>eAnonEnumVal2 anonymous enum value description.');" onmouseout="return nd();">&nbsp;eAnonEnumVal2</a></TD>
<TD class="paddingNormal1"><span class="" ><a href="#" OnMouseOver="link('_member','eAnonEnumVal2171347412',this)">eAnonEnumVal2</a> anonymous enum <b>value</b> description.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','eAnonEnumVal3171347412',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Syntax</strong><BR>enumval&nbsp;&nbsp;eAnonEnumVal3',CAPTION,'<strong>Brief description</strong><BR>eAnonEnumVal3 anonymous enum value description');" onmouseout="return nd();">&nbsp;eAnonEnumVal3</a></TD>
<TD class="paddingNormal1"><span class="" ><a href="#" OnMouseOver="link('_member','eAnonEnumVal3171347412',this)">eAnonEnumVal3</a> anonymous enum <b>value</b> description<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
<TR VALIGN="top">
<TD class="paddingNormal1"><span class="" align=left><a href="#" onMouseOver="link('_member','Enum171347412',this); "><img src="../../common/info.gif" border=0 onmouseover="overLibDiagram();return overlib('<strong>Enumeration Values</strong><BR>eEnumVal1<br>eEnumVal2<br>eEnumVal3<br>',CAPTION,'<strong>Brief description</strong><BR>Enumeration documentation.');" onmouseout="return nd();">&nbsp;Enum</a></TD>
<TD class="paddingNormal1"><span class="" >Enumeration documentation.<br>
</TD>
<TD class="paddingNormal2"><span class="" align=left><a href="#" onMouseOver="link('_class','HowToDocument0',this); ">HowToDocument</a></TD>
</TR>
</table>
<div class="contentAirBottom"></div>
</div>
<script type="text/javascript">
 Body5();
Statistics("","","","","");
 Body6();
SetPageTab('_class','_public');
</script>
